<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RichPlugin | Raxan User Guide</title>
    <link href="../raxan/styles/master.css" rel="stylesheet" type="text/css" />
    <!--[if IE]><link rel="stylesheet" href="../raxan/styles/master.ie.css" type="text/css"><![endif]-->
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        hljs.initHighlightingOnLoad('javascript','html','php');
    </script>

</head>

<body>
    <div class="container c48 prepend-top">
        <h2 class="bottom">Raxan User Guide</h2>
        <div class="navbar">
            <div class="lf"><div class="rt"><div class="md">
                <ul>
                    <li><a href="../index.html" title="The Rich Ajax, CSS &amp; PHP Framework" >Home</a></li>
                    <li><a href="table-of-contents.html" title="Blog Posts" >Table Of Contents</a></li>
                </ul>
            </div></div></div>
        </div>
        <div class="prepend1 append1"><div class="container c45">
    <h2 class="class-name">Class RichPlugin</h2>

    <a name="sec-description"></a>
    <div class="box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
            <span class="disabled">Description</span> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
                        |                                           <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="info-box-body">
            <!-- ========== Info from phpDoc block ========= -->
            <p class="short-description">RichPlugin</p>
            <p class="notes">
            Located in <a class="field" href="#">/shared/rich.element.php</a> (line <span class="field">1101</span>)
            </p>


            <pre><a href="RichAPIBase.html">RichAPIBase</a>
   |
   --<a href="RichElement.html">RichElement</a>
      |
      --RichPlugin</pre>

        </div>
    </div>



    <a name="sec-var-summary"></a>
    <div class="box bmm">
        <div class="box-title">Variable Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
                            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="info-box-body">
            <div class="var-summary">
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$implementPrerender" title="details" class="var-name">$implementPrerender</a>
                </div>
            </div>
        </div>
    </div>

    <a name="sec-method-summary"></a>
    <div class="box bmm">
        <div class="box-title">Method Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

                |
            <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
        </div>
        <div class="info-box-body">
            <div class="method-summary">

                <div class="method-definition">
                    <span class="method-result">RichPlugin</span>
                    <a href="#__construct" title="details" class="method-name">__construct</a>
                                            (<span class="var-type"></span>&nbsp;<span class="var-name">$css</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$context</span> = <span class="var-default">null</span>])
                </div>

                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#dataSource" title="details" class="method-name">dataSource</a>
                                            (<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
                </div>

                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#getUniqueId" title="details" class="method-name">getUniqueId</a>
                                            ([<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">'plug-x'</span>])
                </div>

                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#render" title="details" class="method-name">render</a>
                                        ()
                </div>
            </div>
        </div>
    </div>

    <a name="sec-vars"></a>
    <div class="box bmm">
        <div class="box-title">Variables</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)


                                        |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="info-box-body">
            <a name="var$implementPrerender" id="$implementPrerender"><!-- --></A>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$implementPrerender</span>
             = <span class="var-default"> false</span>          (line <span class="line-number">1103</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <h4>Inherited Variables</h4>
            <A NAME='inherited_vars'><!-- --></A>
            <p>Inherited from <span class="classname"><a href="RichElement.html">RichElement</a></span></p>
            <blockquote>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$autoid">RichElement::$autoid</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$callMethods">RichElement::$callMethods</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$context">RichElement::$context</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$doc">RichElement::$doc</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$elms">RichElement::$elms</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$modified">RichElement::$modified</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$name">RichElement::$name</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$page">RichElement::$page</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$rootElm">RichElement::$rootElm</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$selector">RichElement::$selector</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichElement.html#var$stack">RichElement::$stack</a></span><br>
                </span>
            </blockquote>
            <p>Inherited from <span class="classname"><a href="RichAPIBase.html">RichAPIBase</a></span></p>
            <blockquote>
                <span class="var-title">
                    <span class="var-name"><a href="RichAPIBase.html#var$events">RichAPIBase::$events</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichAPIBase.html#var$mObjId">RichAPIBase::$mObjId</a></span><br>
                </span>
                <span class="var-title">
                    <span class="var-name"><a href="RichAPIBase.html#var$objId">RichAPIBase::$objId</a></span><br>
                </span>
            </blockquote>

        </div>
    </div>

    <a name="sec-methods"></a>
    <div class="box bmm">
        <div class="box-title">Methods</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

        </div>
        <div class="info-box-body">
            <A NAME='method_detail'></A>
            <a name="method__construct" id="__construct"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">Constructor __construct</span> (line <span class="line-number">1105</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">RichPlugin</span>
                    <span class="method-name">
            __construct
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$css</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$context</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$css</span>          </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$context</span>          </li>
                </ul>

                <hr class="separator" />
                <div class="notes">Redefinition of:</div>
                <dl>
                    <dt><a href="RichElement.html#method__construct">RichElement::__construct()</a></dt>
                    <dd>RichElement(css,context)</dd>
                </dl>

            </div>
            <a name="methoddataSource" id="dataSource"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">dataSource</span> (line <span class="line-number">1112</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
            dataSource
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$data</span>         </li>
                </ul>


            </div>
            <a name="methodgetUniqueId" id="getUniqueId"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">getUniqueId</span> (line <span class="line-number">1114</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
            getUniqueId
                    </span>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$prefix</span> = <span class="var-default">'plug-x'</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$prefix</span>           </li>
                </ul>


            </div>
            <a name="methodrender" id="render"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">render</span> (line <span class="line-number">1111</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
            render
                    </span>
                ()
                </div>



            </div>
            <h4>Inherited Methods</h4>
            <a name='inherited_methods'><!-- --></a>
            <!-- =========== Summary =========== -->
            <p>Inherited From <span class="classname"><a href="RichElement.html">RichElement</a></span></p>
            <blockquote>
                <span class="method-name"><a href="RichElement.html#method__construct">RichElement::__construct()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodadd">RichElement::add()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodaddClass">RichElement::addClass()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodaddMethod">RichElement::addMethod()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodafter">RichElement::after()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodandSelf">RichElement::andSelf()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodappend">RichElement::append()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodappendTo">RichElement::appendTo()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodappendToClient">RichElement::appendToClient()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodappendView">RichElement::appendView()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodattr">RichElement::attr()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodbefore">RichElement::before()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodbind">RichElement::bind()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodchildren">RichElement::children()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodclearNode">RichElement::clearNode()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodclick">RichElement::click()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodcloneNodes">RichElement::cloneNodes()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodcreateFragment">RichElement::createFragment()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodcss">RichElement::css()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methoddata">RichElement::data()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methoddelegate">RichElement::delegate()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methoddisable">RichElement::disable()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodenable">RichElement::enable()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodend">RichElement::end()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodeq">RichElement::eq()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodfilter">RichElement::filter()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodfind">RichElement::find()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodget">RichElement::get()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodhasClass">RichElement::hasClass()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodhide">RichElement::hide()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodhtml">RichElement::html()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodinsert">RichElement::insert()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodinsertAfter">RichElement::insertAfter()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodinsertBefore">RichElement::insertBefore()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodis">RichElement::is()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodisHTML">RichElement::isHTML()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodlocalize">RichElement::localize()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodmap">RichElement::map()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodmatchSelector">RichElement::matchSelector()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodmodifyClass">RichElement::modifyClass()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodnext">RichElement::next()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodnextAll">RichElement::nextAll()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodnode">RichElement::node()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodnodeContent">RichElement::nodeContent()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodnot">RichElement::not()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodparent">RichElement::parent()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodparents">RichElement::parents()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodprepend">RichElement::prepend()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodprependTo">RichElement::prependTo()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodprependToClient">RichElement::prependToClient()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodpreserveState">RichElement::preserveState()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodprev">RichElement::prev()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodprevAll">RichElement::prevAll()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodremove">RichElement::remove()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodremoveAttr">RichElement::removeAttr()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodremoveChildren">RichElement::removeChildren()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodremoveClass">RichElement::removeClass()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodremoveData">RichElement::removeData()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodreplaceAll">RichElement::replaceAll()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodreplaceClient">RichElement::replaceClient()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodreplaceWith">RichElement::replaceWith()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodselectInnerChild">RichElement::selectInnerChild()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodsendToClient">RichElement::sendToClient()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodshow">RichElement::show()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodsiblings">RichElement::siblings()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodslice">RichElement::slice()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodstack">RichElement::stack()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodstoreName">RichElement::storeName()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodsubmit">RichElement::submit()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodtext">RichElement::text()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodtimeout">RichElement::timeout()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodtoggleClass">RichElement::toggleClass()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodtraverse">RichElement::traverse()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodtrigger">RichElement::trigger()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodunbind">RichElement::unbind()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodunique">RichElement::unique()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodunstack">RichElement::unstack()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodval">RichElement::val()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodvalue">RichElement::value()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodwrap">RichElement::wrap()</a></span><br>
                <span class="method-name"><a href="RichElement.html#methodwrapAll">RichElement::wrapAll()</a></span><br>
                <span class="method-name"><a href="RichElement.html#method__call">RichElement::__call()</a></span><br>
                <span class="method-name"><a href="RichElement.html#method__get">RichElement::__get()</a></span><br>
            </blockquote>
            <!-- =========== Summary =========== -->
            <p>Inherited From <span class="classname"><a href="RichAPIBase.html">RichAPIBase</a></span></p>
            <blockquote>
                <span class="method-name"><a href="RichAPIBase.html#method__construct">RichAPIBase::__construct()</a></span><br>
                <span class="method-name"><a href="RichAPIBase.html#methodbind">RichAPIBase::bind()</a></span><br>
                <span class="method-name"><a href="RichAPIBase.html#methodlog">RichAPIBase::log()</a></span><br>
                <span class="method-name"><a href="RichAPIBase.html#methodtrigger">RichAPIBase::trigger()</a></span><br>
                <span class="method-name"><a href="RichAPIBase.html#methodunbind">RichAPIBase::unbind()</a></span><br>
            </blockquote>

        </div>
    </div>


    <p class="notes" id="credit">
        Documentation generated on Tue, 18 Aug 2009 01:39:53 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
    </p>
</div>
</div>
        <div class="tpb pad" style="text-align:right">
            <a href="table-of-contents.html" class="quiet">Back to Table of Content</a>
        </div>
    </div>
</body>

</html>

